欢迎来到GenAI模型能效评级体系项目!本指南将帮助您快速搭建开发环境并开始使用本项目。
在开始之前,请确保您的系统满足以下要求:
我们提供了一个自动化的安装脚本,可以帮您完成大部分设置工作:
# 克隆项目
git clone https://github.com/your-org/genai-power-evaluation.git
cd genai-power-evaluation
# 运行安装脚本
chmod +x scripts/setup.sh
./scripts/setup.sh
安装脚本会自动:
如果您更喜欢手动控制每个步骤,可以按照以下步骤进行:
git clone https://github.com/your-org/genai-power-evaluation.git
cd genai-power-evaluation
# 创建虚拟环境
python3 -m venv venv
# 激活虚拟环境
# Linux/macOS:
source venv/bin/activate
# Windows:
venv\Scripts\activate
# 升级pip
pip install --upgrade pip setuptools wheel
# 安装项目依赖
pip install -r requirements.txt
# 进入前端目录
cd frontend
# 安装依赖
npm install
# 返回项目根目录
cd ..
# 复制环境配置模板
cp .env.example .env
# 编辑配置文件(根据您的环境修改)
nano .env
# 运行数据库初始化脚本
python scripts/init_db.py
# 创建数据目录
mkdir -p data/{raw,processed,external}
mkdir -p results logs uploads cache/models
项目支持多种启动方式,您可以根据需要选择:
# 激活虚拟环境
source venv/bin/activate # Linux/macOS
# 或
venv\Scripts\activate # Windows
# 启动后端服务
python -m src.backend.main
后端服务将在 http://localhost:8000 启动,您可以访问:
# 进入前端目录
cd frontend
# 启动开发服务器
npm run dev
前端服务将在 http://localhost:5173 启动。
如果您安装了Docker,可以使用Docker Compose一键启动所有服务:
# 启动所有服务
docker-compose up -d
# 查看服务状态
docker-compose ps
# 查看服务日志
docker-compose logs -f [service_name]
这将启动以下服务:
对于生产环境部署,我们提供了专门的配置:
# 构建前端生产版本
cd frontend
npm run build
cd ..
# 使用生产配置启动
docker-compose -f docker-compose.prod.yml up -d
安装完成后,您可以通过以下方式验证系统是否正常运行:
# 检查后端服务状态
curl http://localhost:8000/health
# 预期响应: {"status": "healthy", "timestamp": "..."}
# 运行Python测试
pytest tests/ -v
# 运行前端测试
cd frontend && npm test
打开浏览器访问 http://localhost:3000,您应该能看到项目的主界面。
症状: pip安装时出现编译错误或依赖冲突
解决方案:
# 升级pip和工具
pip install --upgrade pip setuptools wheel
# 使用清华镜像源
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
# 如果仍然失败,尝试单独安装问题包
pip install package-name --no-cache-dir
症状: npm install出现网络错误或权限问题
解决方案:
# 清理npm缓存
npm cache clean --force
# 使用淘宝镜像
npm config set registry https://registry.npmmirror.com
# 重新安装
npm install
症状: 后端启动时报数据库连接错误
解决方案:
# 检查数据库服务是否启动
# 如果使用Docker:
docker-compose logs postgres
# 检查数据库配置
grep DATABASE_URL .env
# 手动初始化数据库
python scripts/init_db.py
症状: 启动服务时提示端口已被使用
解决方案:
# 查看端口使用情况
# Linux/macOS:
lsof -i :8000
# Windows:
netstat -ano | findstr :8000
# 修改配置文件中的端口
# 编辑 .env 文件,修改相应的端口配置
症状: 评估过程中模型下载超时或失败
解决方案:
# 检查网络连接
ping huggingface.co
# 设置代理(如果需要)
export HTTP_PROXY=http://your-proxy:port
export HTTPS_PROXY=http://your-proxy:port
# 使用国内镜像源
# 在配置文件中设置Hugging Face镜像
恭喜您成功搭建GenAI模型能效评级体系!接下来您可以:
如果您遇到问题或需要帮助,可以通过以下方式联系我们:
本项目采用MIT许可证,详见 LICENSE 文件。
祝您使用愉快! 🎉